#%RAML 1.0

    title: Party API
    baseUri: http://localhost:8081
    version: v1
    
    documentation:
      - title: mod-party API
        content: This documents the API calls that can be made to post party for users, and to get them
    
    types:
      auxiliary: !include auxiliary.json
      auxiliaryCollection: !include auxiliaryCollection.json
      errors: !include raml-util/schemas/errors.schema
    
    traits:
      validate: !include raml-util/traits/validation.raml
      language: !include raml-util/traits/language.raml
      pageable:  !include raml-util/traits/pageable.raml
      searchable: !include raml-util/traits/searchable.raml
    
    resourceTypes:
      collection: !include raml-util/rtypes/collection.raml
      collection-item: !include raml-util/rtypes/item-collection.raml
    
    /party/auxiliary:
      displayName: auxiliary
      description: auxiliary from the system to some user
      type:
        collection:
          schemaCollection: auxiliaryCollection
          schemaItem: auxiliary
          exampleCollection: !include examples/auxiliaryCollection.sample
          exampleItem: !include examples/auxiliary.sample
    
      post:
        is: [validate]
      get:
        is: [
          searchable: {description: "with valid searchable fields: for example link = 1234", example: "link=/users/1234"},
          pageable,
          validate
        ]

      /{id}:
          displayName: auxiliary
          description: Get, Delete or Update a specific auxiliary
          type:
            collection-item:
              schema: auxiliary
              exampleItem: !include examples/auxiliary.sample
    